Microsoft Learning Components
MLC Session Frameset
Summary

The MLC Session Frameset is a collection of ASP.NET pages that are used within applications to allow a user to interact with e-learning content. The user interface components of the frameset can be easily customized for an application, while the core frameset client javascript and server ASP.NET code manage the display of content and processing of learner actions and are common between instances of the frameset.

There are two applications in SharePointLearning Kit that use the session frameset. BasicWebPlayer is sample code that runs as a compile-on-demand ASP.NET Web application. SharePoint Learning Kit (SLK) includes a Session Frameset as part of its SharePoint solution. From a user's perspective, the framesets appear very similar, with almost identical functionality, as shown here:

While the applications appear similar to a user, there are several differences in the applications:

Accessing the Session Frameset

The SLK and BWP session framesets have different URL parameters. When installed SLK and BasicWebPlayer are installed, the framesets are accessed as follows:

Basic Web Player: http://MyServer/BasicWebPlayer/Frameset/Frameset.aspx?View=<sessionView>&AttemptId=<attemptId> where


Information on running Basic Web Player can be found in the readme.

SharePoint Learning Kit: https://MyServer/MySite/_layouts/SharePointLearningKit/Frameset/Frameset.aspx?SlkView=<slkView>&LearnerAssignmentId=<learnerAssignmentId> where

Note that the availability of a particular view to a given user is determined by the security rules of the application. For instance, in SLK, a learner cannot request StudentReview if the assignment is not Final.
Slk View
In SLK, a SlkView URL parameter to the session frameset determines the MLC SessionView displayed to the user, according the following correlation:

SlkView MLC SessionView Comment
Execute SessionView.Execute Security rules and the SLK session frameset limit this view to the learner of the LearnerAssignment and assignments that are NotStarted or Active.
StudentReviewSessionView.Review Security rules and the SLK session frameset limit this view to the learner of the LearnerAssignment and assignments that are Final.
InstructorReviewSessionView.Review Security rules and the SLK session frameset limit this view to instructors on the assignment.
GradingSessionView.RandomAccess Security rules and SLK session frameset limit this view to instructors on submitted or final LearnerAssignments.
Session Frameset Source Code
The source code for the session framesets are available in the following locations:

The precise location of files within the framesets is defined below.

As mentioned above, the session framest can be roughly categorized into three sections:
  1. Code to display the user interface of the Basic Web Player application session frameset.
  2. Code to display the user interface of the SLK application session frameset.
  3. Code shared between the SLK and Basic Web Player applications. This is the majority of the code in the session frameset. Application developers should not need to change these files to provide a frameset within your application. The source code of these files is stored with the Basic Web Player frameset and copied to the SlkDll project at build time.
Specifically, the session framesets consist of the following files:

BasicWebPlayer frameset files

Root Folder: <SourceCode>\Samples\BasicWebPlayer\Frameset

Relative Path Description
ChangeActivity.aspx and ChangeActivity.aspx.csPage displayed when LRM content contains a relative reference to another page in the content. Parses the URL parameters unique to BasicWebPlayer and uses ChangeActivityHelper to actually change the activity.
ClearContent.aspx and ClearContent.aspx.csPage displayed when package content is being removed from display, for instance when a user selects a new activity in the table of contents.
Content.aspx and Content.aspx.csPage displayed in the content frame. Parses the URL parameters unique to BasicWebPlayer and uses ContentHelper to display the content.
Frameset.aspx and Frameset.aspx.csThe main page displayed in the frameset. Parses URL parameters unique to BasicWebPlayer and uses FramesetHelper to initialize the LearningSession for display in the frameset.
Hidden.aspx and Hidden.aspx.csPage that is within the frameset but not displayed to the user. Parses URL parameters unique to BasicWebPlayer and uses HiddenHelper to process commands sent from the client.
MainFrames.aspx and MainFrames.aspx.csFrameset embedded within the overall frameset, that contains the table of contents, navigation panes, and contents frames. Provides href values unique to BasicWebPlayer for the frames it contains.
NavClosed.aspx and NavClosed.aspx.csPage containing navigation icons when the table of contents is not displayed. Provides strings unique to BasicWebPlayer.
NavOpen.aspx and NavOpen.aspx.csPage containing navigation icons when the table of contents is displayed. Provides strings unique to BasicWebPlayer.
TOC.aspx and TOC.aspx.csPage displaying the table of contents. unique to BasicWebPlayer and uses TocHelper to display the table of contents.
App_Code\FramesetPage.csThe base class of all *.aspx.cs classes in the BasicWebPlayerFrameset. Provides common protected methods for URL parameter parsing and error display.


Slk Session frameset files

Root Folder (*.cs): <SourceCode>\Slk\SlkDll\AppWebPages\Frameset
Root Folder (*.aspx): <SourceCode>\Slk\App\Frameset

Relative Path Description
ChangeActivity.aspx and ChangeActivity.aspx.csPage displayed when LRM content contains a relative reference to another page in the content. Parses the URL parameters unique to SLK and uses ChangeActivityHelper to actually change the activity.
ClearContent.aspx and ClearContent.aspx.csPage displayed when package content is being removed from display, for instance when a user selects a new activity in the table of contents.
Content.aspx and Content.aspx.csPage displayed in the content frame. Parses the URL parameters unique to SLK and uses ContentHelper to display the content.
Frameset.aspx and Frameset.aspx.csThe main page displayed in the frameset. Parses URL parameters unique to SLK and uses FramesetHelper to initialize the LearningSession for display in the frameset. This page is also responsible for rendering non-e-learning content.
Hidden.aspx and Hidden.aspx.csPage that is within the frameset but not displayed to the user. Parses URL parameters unique to SLK and uses HiddenHelper to process commands sent from the client.
MainFrames.aspx and MainFrames.aspx.csFrameset embedded within the overall frameset, that contains the table of contents, navigation panes, and contents frames. Provides href values unique to SLK for the frames it contains.
NavClosed.aspx and NavClosed.aspx.csPage containing navigation icons when the table of contents is not displayed. Provides strings unique to SLK.
NavOpen.aspx and NavOpen.aspx.csPage containing navigation icons when the table of contents is displayed. Provides strings unique to SLK.
SlkFramesetPage.csThe base class for all SLK frameset *.aspx.cs classes. Provides protected methods to assist in URL parsing, error handling and rendering of SLK-specific client script.
SlkFramesetQueryParam.cs (in <SourceCode>\Slk\SlkDll) Partial class to define URL parameters used by the SLK frameset.
TOC.aspx and TOC.aspx.csPage displaying the table of contents. unique to SLK and uses TocHelper to display the table of contents.


Core Session Frameset Files (shared between SLK and BasicWebPlayer)

Root Folder (*.cs): <SourceCode>\Samples\BasicWebPlayer

Relative Path Description
Frameset\Theme\*.*The stylesheet and images that are used within in the frameset user interface.
Frameset\Images\*.*Images used when rendering content, specifically LRM content.
Frameset\Include\*.*JavaScript files for client processing. Includes the RTE implementations for SCORM 2004 and SCORM 1.2, as well as a variety of functions that manage the processing of information between frames of the frameset.
Frameset\Bottom.htmBlank page used for spacing in the frameset.
Frameset\NoScroll.htmBlank page used for spacing in the frameset.
Frameset\Title.htmPage displayed in the title frame. The title (the form of which differs in the BasicWebPlayer and SLK framesets) is set by client code running in the hidden frame.
App_Code\ChangeActivityHelper.csCode used by ChangeActivity.cs to change an activity within LRM content.
App_Code\ContentHelper.csCode to display content within the content frame. When LRM content is being displayed, this frame is posted to the server containing user interaction data from the client.
App_Code\Encoding.csHelper functions to encode and decode various string formats.
App_Code\FramesetHelper.csCode to initialize the LearningSession for display in the frameset.
App_Code\FramesetQueryParam.csPartial class that defines costants for URL parameters. SLK frameset also provides a partial class to extend this list; BasicWebPlayer does not.
App_Code\FrmPageHelper.csCode used by SLK FramesetPage and BasicWebPlayer BwpFramesetPage to perform common methods for accessing URL parameter and processing errors.
App_Code\HiddenHelper.csCode to assist in rendering the hidden page. When LRM content is not being displayed, this frame is posted to the server containing user interaction data from the client.
App_Code\Log.csDebug-only logging classes. By default, is not referenced by any other classes, but can be used as generic logging functionality for debugging server interactions.
App_Code\PostableFrameHelper.csBase class of helper classes that can be posted, specifically ContentHelper and HiddenHelper.
App_Code\Rte1p2DataModelConverter.csConverts data model elements from SCORM 1.2 content to LearningDataModel elements, and vice versa.
App_Code\Rte2004DataModelConverter.csConverts data model elements from 2004 content to LearningDataModel elements, and vice versa.
App_Code\RteDataModelConverter.csAbstract class to translate between RTE strings (e.g., "cmi.score.scaled") and LearningDataModel values (e.g., LearningDataModel.Score.Scaled). Rte1p2DataModelConverter and Rte2004DataModelConverter inherit from this class.
App_Code\TocHelper.csRenders the table of contents.
For More Information
Microsoft.LearningComponents Namespace (API Reference)
Microsoft.LearningComponents.DataModel Namespace (API Reference)
Microsoft.LearningComponents.Storage Namespace (API Reference)
Next Topic: LearningStore Schema Reference